chore: Add checkout submodules #17
Conversation
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds support for checking out Git submodules in the GitHub Action workflow by introducing a new checkout-submodules input parameter. The change enables users to specify whether submodules should be fetched during the checkout process, with support for true, false, or recursive values.
Changes:
- Added
checkout-submodulesinput parameter to the action configuration with a default value offalse - Updated checkout logging to display the submodules configuration value
- Modified the checkout step to pass the submodules parameter to the underlying actions/checkout action
- Updated documentation and test workflows to reflect the new parameter
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| action.yml | Added checkout-submodules input definition, logging output, and parameter passing to checkout action |
| README.md | Added checkout-submodules parameter documentation to the Repository Checkout table |
| .github/workflows/test.yml | Added checkout-submodules: false to test workflows to exercise the new parameter |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
This pull request introduces support for configuring submodule checkout behavior in the repository's GitHub Actions workflows and composite action. The changes add a new
checkout-submodulesinput, update documentation to reflect the new option, and ensure the value is correctly passed through workflow jobs and actions.Support for submodule checkout in workflows and actions:
checkout-submodulesinput toaction.yml, allowing users to specify whether submodules should be fetched during checkout (true,false, orrecursive).checkout-submodulesand to pass it to theactions/checkoutstep. [1] [2].github/workflows/test.ymlto setcheckout-submodules: falsewhere appropriate. [1] [2]Documentation updates:
README.mdto document the newcheckout-submodulesinput, including its description, default value, and options.Related Issue(s)
Closes #16